API

Procurement APIs

POST procurement/returns/{supplierReturnId}/notifications

Creates a new notification in this supplier return

HTTP method POST
URI https://api.rambase.net/procurement/returns/{supplierReturnId}/notifications
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierReturnId} Supplier return identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 3240, version 2

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Notification
Notification

This field is optional.

>
2
     <RegardingItem
RegardingItem

This field is optional.

>
3
          <ItemId
ItemId

Item-number of the object

This field is optional.

>
{Integer}</ItemId>
4
     </RegardingItem>
5
     <MessageParameters
MessageParameters

Parameters used when expanding the message.

This field is optional.

>
6
          <MessageParameter
MessageParameter

This field is optional.

>
7
               <Key
Key

Key of the message parameter. Found in the message of the notification definition.

This field is optional.

>
{String}</Key>
8
               <Value
Value

The value that replaces the key in the message of the notification definition.

This field is optional.

>
{String}</Value>
9
          </MessageParameter>
10
     </MessageParameters>
11
     <NotificationType
NotificationType

This field is optional.

>
12
          <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is optional.

>
{String}</NotificationTypeId>
13
     </NotificationType>
14
</Notification>
1
{
2
     "notification
Notification

This field is optional.

":
{
3
          "regardingItem
RegardingItem

This field is optional.

":
{
4
               "itemId
ItemId

Item-number of the object

This field is optional.

":
"{Integer}"
5
          },
6
          "messageParameters
MessageParameters

Parameters used when expanding the message.

This field is optional.

":
[
7
               {
8
                    "key
Key

Key of the message parameter. Found in the message of the notification definition.

This field is optional.

":
"{String}",
9
                    "value
Value

The value that replaces the key in the message of the notification definition.

This field is optional.

":
"{String}"
10
               }
11
          ],
12
          "notificationType
NotificationType

This field is optional.

":
{
13
               "notificationTypeId
NotificationTypeId

Notification type identifier

This field is optional.

":
"{String}"
14
          }
15
     }
16
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Notification>
2
     <NotificationId
NotificationId

Notification identifier

>
{Integer}</NotificationId>
3
     <Status
Status

Status of the notification

Possible domain values can be found here

>
{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
5
     <Message
Message

The message from the notification definition, expanded with parameters.

>
{String}</Message>
6
     <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

>
{String}</TranslatedMessage>
7
     <Approval>
8
          <Priority
Priority

Requested priority of the approval request.

Possible domain values can be found here

>
9
               <ApprovalRuleId
ApprovalRuleId

Approval rule identifier

>
{Integer}</ApprovalRuleId>
10
               <Name
Name

Name of the approval rule

>
{String}</Name>
11
               <Description
Description

Approval rule description

>
{String}</Description>
12
               <SendRequestToDefaultApprovers
SendRequestToDefaultApprovers

Send request to all approvers selected as default approvers

>
{Boolean}</SendRequestToDefaultApprovers>
13
               <ApprovalRuleLink
ApprovalRuleLink

Approval rule reference

>
{String}</ApprovalRuleLink>
14
          </Priority>
15
          <Request>
16
               <Value
Value

Value which was approved (if approved).

>
{String}</Value>
17
               <Comment
Comment

Message entered by the user when requesting approval

>
{String}</Comment>
18
               <Approver>
19
                    <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
20
                    <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
21
               </Approver>
22
          </Request>
23
          <Response>
24
               <IsApproved
IsApproved

True if the notification needs approval, and is approved.

>
{Boolean}</IsApproved>
25
               <Comment
Comment

Message entered by the user when approving or denying the approval request

>
{String}</Comment>
26
               <ReviewedAt
ReviewedAt

Date and time of approvel.

>
{Datetime}</ReviewedAt>
27
               <ReviewedBy
ReviewedBy

The employee who approved the notification.

>
28
                    <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
29
                    <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
30
               </ReviewedBy>
31
          </Response>
32
     </Approval>
33
     <MessageParameters
MessageParameters

Parameters used when expanding the message.

>
34
          <MessageParameter>
35
               <Key
Key

Key of the message parameter. Found in the message of the notification definition.

>
{String}</Key>
36
               <Value
Value

The value that replaces the key in the message of the notification definition.

>
{String}</Value>
37
          </MessageParameter>
38
     </MessageParameters>
39
     <CreatedBy
CreatedBy

The user who created the notification.

>
40
          <UserId
UserId

User identifier

>
{Integer}</UserId>
41
          <UserLink
UserLink

User reference

>
{String}</UserLink>
42
     </CreatedBy>
43
     <NotificationType>
44
          <NotificationTypeId
NotificationTypeId

Notification type identifier

>
{String}</NotificationTypeId>
45
          <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

>
{String}</Category>
46
          <Priority
Priority

Priority of notification with this notification type.

>
{String}</Priority>
47
          <ForwardNotifications
ForwardNotifications

True if notifications created with this definition will be forwarded when the owner object is forwarded.

>
{Boolean}</ForwardNotifications>
48
          <NotificationTypeLink
NotificationTypeLink

Notification type reference

>
{String}</NotificationTypeLink>
49
     </NotificationType>
50
</Notification>
1
{
2
     "notification": {
3
          "notificationId
NotificationId

Notification identifier

":
"{Integer}",
4
          "status
Status

Status of the notification

Possible domain values can be found here

":
"{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
6
          "message
Message

The message from the notification definition, expanded with parameters.

":
"{String}",
7
          "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

":
"{String}",
8
          "approval": {
9
               "priority
Priority

Requested priority of the approval request.

Possible domain values can be found here

":
{
10
                    "approvalRuleId
ApprovalRuleId

Approval rule identifier

":
"{Integer}",
11
                    "name
Name

Name of the approval rule

":
"{String}",
12
                    "description
Description

Approval rule description

":
"{String}",
13
                    "sendRequestToDefaultApprovers
SendRequestToDefaultApprovers

Send request to all approvers selected as default approvers

":
"{Boolean}",
14
                    "approvalRuleLink
ApprovalRuleLink

Approval rule reference

":
"{String}"
15
               },
16
               "request": {
17
                    "value
Value

Value which was approved (if approved).

":
"{String}",
18
                    "comment
Comment

Message entered by the user when requesting approval

":
"{String}",
19
                    "approver": {
20
                         "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
21
                         "employeeLink
EmployeeLink

Employee reference

":
"{String}"
22
                    }
23
               },
24
               "response": {
25
                    "isApproved
IsApproved

True if the notification needs approval, and is approved.

":
"{Boolean}",
26
                    "comment
Comment

Message entered by the user when approving or denying the approval request

":
"{String}",
27
                    "reviewedAt
ReviewedAt

Date and time of approvel.

":
"{Datetime}",
28
                    "reviewedBy
ReviewedBy

The employee who approved the notification.

":
{
29
                         "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
30
                         "employeeLink
EmployeeLink

Employee reference

":
"{String}"
31
                    }
32
               }
33
          },
34
          "messageParameters
MessageParameters

Parameters used when expanding the message.

":
[
35
               {
36
                    "key
Key

Key of the message parameter. Found in the message of the notification definition.

":
"{String}",
37
                    "value
Value

The value that replaces the key in the message of the notification definition.

":
"{String}"
38
               }
39
          ],
40
          "createdBy
CreatedBy

The user who created the notification.

":
{
41
               "userId
UserId

User identifier

":
"{Integer}",
42
               "userLink
UserLink

User reference

":
"{String}"
43
          },
44
          "notificationType": {
45
               "notificationTypeId
NotificationTypeId

Notification type identifier

":
"{String}",
46
               "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

":
"{String}",
47
               "priority
Priority

Priority of notification with this notification type.

":
"{String}",
48
               "forwardNotifications
ForwardNotifications

True if notifications created with this definition will be forwarded when the owner object is forwarded.

":
"{Boolean}",
49
               "notificationTypeLink
NotificationTypeLink

Notification type reference

":
"{String}"
50
          }
51
     }
52
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found